Telegram Bot/eu.vendeli.tgbot.types.keyboard/KeyboardButtonRequestChat

KeyboardButtonRequestChat

@Serializable

data class KeyboardButtonRequestChat(val requestId: Int, val chatIsChannel: Boolean, val chatIsForum: Boolean? = null, val chatHasUsername: Boolean? = null, val chatIsCreated: Boolean? = null, val userAdministratorRights: ChatAdministratorRights? = null, val botAdministratorRights: ChatAdministratorRights? = null, val botIsMember: Boolean? = null, val requestTitle: Boolean? = null, val requestUsername: Boolean? = null, val requestPhoto: Boolean? = null)

This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate. More about requesting chats: https://core.telegram.org/bots/features#chat-and-user-selection.

Api reference

Constructors

KeyboardButtonRequestChat

constructor(requestId: Int, chatIsChannel: Boolean, chatIsForum: Boolean? = null, chatHasUsername: Boolean? = null, chatIsCreated: Boolean? = null, userAdministratorRights: ChatAdministratorRights? = null, botAdministratorRights: ChatAdministratorRights? = null, botIsMember: Boolean? = null, requestTitle: Boolean? = null, requestUsername: Boolean? = null, requestPhoto: Boolean? = null)

Properties

botAdministratorRights

val botAdministratorRights: ChatAdministratorRights? = null

Optional. A JSON-serialized object listing the required administrator rights of the bot in the chat. The rights must be a subset of user_administrator_rights. If not specified, no additional restrictions are applied.

botIsMember

val botIsMember: Boolean? = null

Optional. Pass True to request a chat with the bot as a member. Otherwise, no additional restrictions are applied.

chatHasUsername

val chatHasUsername: Boolean? = null

Optional. Pass True to request a supergroup or a channel with a username, pass False to request a chat without a username. If not specified, no additional restrictions are applied.

chatIsChannel

val chatIsChannel: Boolean

Pass True to request a channel chat, pass False to request a group or a supergroup chat.

chatIsCreated

val chatIsCreated: Boolean? = null

Optional. Pass True to request a chat owned by the user. Otherwise, no additional restrictions are applied.

chatIsForum

val chatIsForum: Boolean? = null

Optional. Pass True to request a forum supergroup, pass False to request a non-forum chat. If not specified, no additional restrictions are applied.

requestId

val requestId: Int

Signed 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique within the message

requestPhoto

val requestPhoto: Boolean? = null

Optional. Pass True to request the chat's photo

requestTitle

val requestTitle: Boolean? = null

Optional. Pass True to request the chat's title

requestUsername

val requestUsername: Boolean? = null

Optional. Pass True to request the chat's username

userAdministratorRights

val userAdministratorRights: ChatAdministratorRights? = null

Optional. A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of bot_administrator_rights. If not specified, no additional restrictions are applied.